ci: Add docs rtd check on `kedro-datasets` #299

merelcht · 2023-08-10T14:32:15Z

Description

Temporary solution for: #261

Development notes

This approach adds a build that runs:
python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck

This is the check in the read the docs builds that flags syntax issues etc in the docs. It's also the check that has failed and blocked Kedro releases previously, because there were syntax errors in the datasets doc strings that are not caught by the regular linters.

Questions for reviewers

Is this check sufficient or would it be better to run the full read the docs build here as well or even producing full docs? The original issue proposes adding docs to this repo, whereas this solution only runs the check to discover syntax issues. UPDATE: I'd suggest getting this in temporarily but still implement the subproject RTD stuff properly and then just removing this build step when that's in place.
I copied over the docs config from the core kedro repo and then removed files/lines in conf.py that weren't necessary. I wasn't sure about any files in source/_templates. Are those needed @astrojuanlu / @stichbury ?
Any other parts that can potentially be removed, especially from conf.py if we're happy with just running the check instead of producing full docs?

Checklist

Opened this PR as a 'Draft Pull Request' if it is work-in-progress
Updated the documentation to reflect the code changes
Added a description of this change in the relevant RELEASE.md file
Added tests to cover my changes

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

stichbury · 2023-08-11T10:58:17Z

Hi @merelcht I am sorry I wasn't more clued in to what you were working on with this as we could have discussed in advance what the overall plan is...which is indeed to move the docs into a RTD subproject per kedro-org/kedro#2600 (which means moving the docs into this repo, creating a new subproject on RTD etc.).

I think what you've done is fine but probably it doesn't go far enough to meet that subproject goal, although I'm still not totally clear because I can't see the RTD subproject (if you've created it, please could you add me as admin https://readthedocs.org/profiles/stichbury/ ?

merelcht · 2023-08-14T11:08:42Z

Hi @merelcht I am sorry I wasn't more clued in to what you were working on with this as we could have discussed in advance what the overall plan is...which is indeed to move the docs into a RTD subproject per kedro-org/kedro#2600 (which means moving the docs into this repo, creating a new subproject on RTD etc.).

I think what you've done is fine but probably it doesn't go far enough to meet that subproject goal, although I'm still not totally clear because I can't see the RTD subproject (if you've created it, please could you add me as admin https://readthedocs.org/profiles/stichbury/ ?

My approach now doesn't move the docs into a RTD subproject. Instead I went for a quick fix approach to make sure that for the coming releases we don't get blocked again by syntax problems in kedro-datasets. This solution only runs python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck on the kedro-datasets "docs", which are basically just the docstrings.

I'd suggest getting this in temporarily but then when the RTD subproject has been setup properly remove this build step again. I assumed that the RTD setup will take more time and I wanted to fix this blocker quickly 😄

astrojuanlu · 2023-08-14T11:18:51Z

Setting up RTD might actually take less 😄 in any case, the initial work of doing sphinx-quickstart seems to be already done, so whether the sphinx-build command runs on GHA or RTD doesn't matter. But eventually we'll want an RTD project so that we can combine the docs of both projects.

I'd take care of this myself but I don't have permissions. Will try to review the current approach locally in the meantime.

merelcht · 2023-08-14T11:20:34Z

I'd take care of this myself but I don't have permissions. Will try to review the current approach locally in the meantime.

What do you need permission for? Maybe I can grant it 😃

astrojuanlu

I gave this a quick try locally, found this error after installing the dependencies:

$ cd kedro-datasets/docs && sphinx-build -WETan -j auto -D language=en -b linkcheck -d _build/doctrees source _build/linkcheck
[...looooong list of DeprecationWarning...]
[08/14/23 13:30:16] WARNING  /Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/ warnings.py:109
                             site-packages/kedro_datasets/yaml/yaml_dataset.py:10:                         
                             DeprecationWarning: 'DataSetError' has been renamed to                        
                             'DatasetError', and the alias will be removed in Kedro 0.19.0                 
                               from kedro.io.core import (                                                 
                                                                                                           

Traceback (most recent call last):
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 395, in generate_autosummary_docs
    name, obj, parent, modname = import_by_name(entry.name)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 661, in import_by_name
    raise ImportExceptionGroup('no module named %s' % ' or '.join(tried), exceptions)
sphinx.ext.autosummary.ImportExceptionGroup: no module named kedro_datasets.pandas.DeltaTableDataSet

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 400, in generate_autosummary_docs
    name, obj, parent, modname = import_ivar_by_name(entry.name)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 732, in import_ivar_by_name
    raise ImportError
ImportError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/application.py", line 262, in __init__
    self._init_builder()
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/application.py", line 335, in _init_builder
    self.events.emit('builder-inited')
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/events.py", line 94, in emit
    results.append(listener.handler(self.app, *args))
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 811, in process_generate_options
    generate_autosummary_docs(genfiles, suffix=suffix, base_path=app.srcdir,
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 409, in generate_autosummary_docs
    logger.warning(__('[autosummary] failed to import %s.\nPossible hints:\n%s'),
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1847, in warning
    self.log(WARNING, msg, *args, **kwargs)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/util/logging.py", line 123, in log
    super().log(level, msg, *args, **kwargs)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1879, in log
    self.logger.log(level, msg, *args, **kwargs)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1547, in log
    self._log(level, msg, args, **kwargs)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1624, in _log
    self.handle(record)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1634, in handle
    self.callHandlers(record)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1696, in callHandlers
    hdlr.handle(record)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 964, in handle
    rv = self.filter(record)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 821, in filter
    result = f.filter(record)
  File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/util/logging.py", line 426, in filter
    raise exc
sphinx.errors.SphinxWarning: [autosummary] failed to import kedro_datasets.pandas.DeltaTableDataSet.
Possible hints:
* ImportError: 
* ModuleNotFoundError: No module named 'kedro_datasets.pandas.DeltaTableDataSet'
* AttributeError: module 'kedro_datasets.pandas' has no attribute 'DeltaTableDataSet'

Warning, treated as error:
[autosummary] failed to import kedro_datasets.pandas.DeltaTableDataSet.
Possible hints:
* ImportError: 
* ModuleNotFoundError: No module named 'kedro_datasets.pandas.DeltaTableDataSet'
* AttributeError: module 'kedro_datasets.pandas' has no attribute 'DeltaTableDataSet'

This is probably related to kedro-org/kedro#2871 (comment), we never opened an issue on this side I think.

After I did pip install ./kedro-datasets[all,pandas-deltatabledataset], I tried again and complained about kedro_datasets.snowflake.SnowparkTableDataSet.

.github/workflows/check-plugin.yml

astrojuanlu · 2023-08-14T15:06:03Z

For the record, the kedro-datasets project now exists on Read the Docs! With your permission @merelcht I'll push a .readthedocs.yml file to this branch. I'm not sure if we'll see the RTD check appear here (maybe we'll need to merge first)

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

astrojuanlu · 2023-08-14T16:52:04Z

RTD builds are on now: https://readthedocs.org/projects/kedro-plugins/builds/21606215/

astrojuanlu · 2023-08-14T16:52:41Z

Aaaaand it worked! https://kedro-plugins--299.org.readthedocs.build/en/299/kedro_datasets.html

merelcht · 2023-08-15T07:31:47Z

Both your links return 404 for me @astrojuanlu 🤔 But I can see the checks passed!

stichbury

Happy to approve this. Thanks @merelcht!

astrojuanlu · 2023-08-15T08:17:40Z

I requested a rename and it happened overnight, now it's https://readthedocs.org/projects/kedro-datasets/builds/21613210/

SajidAlamQB

🚀

noklam · 2023-08-15T08:52:06Z

What's the two different RTD build? One is giving me 404 error.

astrojuanlu · 2023-08-15T09:08:50Z

Project URL changed from kedro-plugins to kedro-datasets

* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com>

* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>

…#303) * feat: move default mode of ManagedTableDataSet to read-only default of `write_mode` is None preventing `save` by default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Update kedro-datasets/kedro_datasets/databricks/managed_table_dataset.py Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * added entry to RELEASE.md Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * docs: Fix broken link to datasets docs in README.md (#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * ci: Add docs rtd check on `kedro-datasets` (#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * update docstring Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Merge branch 'main' into managed-table-dataset-read-only-by-default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> --------- Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>

* Add CONTRIBUTING.md file to the Kedro-Plugins repository Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * docs: Fix broken link to datasets docs in README.md (#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * ci: Add docs rtd check on `kedro-datasets` (#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): do not double encode the data as json when saving an A… (#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * build(datasets): release 1.5.2 (#305) * release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Add plugin contribution details to CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Apply minor changes on CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Push code of conduct text block to the top on CONTRIBUTING.md Signed-off-by: L. R. Couto <laurarccouto@gmail.com> * Fix trailing whitespace lint error Signed-off-by: L. R. Couto <laurarccouto@gmail.com> --------- Signed-off-by: lrcouto <laurarccouto@gmail.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

…kedro-org#303) * feat: move default mode of ManagedTableDataSet to read-only default of `write_mode` is None preventing `save` by default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (kedro-org#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Update kedro-datasets/kedro_datasets/databricks/managed_table_dataset.py Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * added entry to RELEASE.md Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * docs: Fix broken link to datasets docs in README.md (kedro-org#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * ci: Add docs rtd check on `kedro-datasets` (kedro-org#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * update docstring Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Merge branch 'main' into managed-table-dataset-read-only-by-default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> --------- Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>

…-org#294) * Add CONTRIBUTING.md file to the Kedro-Plugins repository Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (kedro-org#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * docs: Fix broken link to datasets docs in README.md (kedro-org#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * ci: Add docs rtd check on `kedro-datasets` (kedro-org#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): do not double encode the data as json when saving an A… (kedro-org#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * build(datasets): release 1.5.2 (kedro-org#305) * release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Add plugin contribution details to CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Apply minor changes on CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Push code of conduct text block to the top on CONTRIBUTING.md Signed-off-by: L. R. Couto <laurarccouto@gmail.com> * Fix trailing whitespace lint error Signed-off-by: L. R. Couto <laurarccouto@gmail.com> --------- Signed-off-by: lrcouto <laurarccouto@gmail.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

merelcht added 10 commits August 10, 2023 15:28

Try adding docs rtd check on kedro datasets

5d118fb

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Fix setup

f838f46

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Add runs-on

8198bad

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Fix matrix

ac2c75b

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Fix cd

4a88ead

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Add more setup

f2f007e

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

also install test reqs

2b3a32b

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Remove unnessary doc files

ec7cd00

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Remove static files

fddd6db

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Remove unnecessary stuff from conf.py + lint

8057813

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

merelcht changed the title ~~Try adding docs rtd check on kedro datasets~~ ci:Add docs rtd check on kedro-datasets Aug 10, 2023

merelcht changed the title ~~ci:Add docs rtd check on kedro-datasets~~ ci(rtd):Add docs rtd check on kedro-datasets Aug 10, 2023

merelcht changed the title ~~ci(rtd):Add docs rtd check on kedro-datasets~~ ci: Add docs rtd check on kedro-datasets Aug 10, 2023

merelcht added 3 commits August 10, 2023 19:41

Add back snowparkdataset

0710b4f

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Use python 3.8 for RTD build

01c1b6b

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

Remove matrix build setup

a28a3aa

Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>

merelcht marked this pull request as ready for review August 11, 2023 08:51

merelcht self-assigned this Aug 11, 2023

merelcht requested review from astrojuanlu, stichbury and ankatiyar August 11, 2023 08:52

This comment was marked as resolved.

Sign in to view

astrojuanlu reviewed Aug 14, 2023

View reviewed changes

.github/workflows/check-plugin.yml Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

astrojuanlu added 2 commits August 14, 2023 17:29

Add Read the Docs configuration for kedro-datasets

72871dc

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

Small fixes in Sphinx configuration

d2d2350

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

astrojuanlu force-pushed the try-rtd-builds branch from d1315c2 to d2d2350 Compare August 14, 2023 15:29

merelcht and others added 2 commits August 14, 2023 16:55

Merge branch 'main' into try-rtd-builds

afa0855

Fix RTD config

0b432b2

Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>

astrojuanlu force-pushed the try-rtd-builds branch from 73ce53a to 0b432b2 Compare August 14, 2023 16:46

ankatiyar approved these changes Aug 15, 2023

View reviewed changes

stichbury approved these changes Aug 15, 2023

View reviewed changes

SajidAlamQB approved these changes Aug 15, 2023

View reviewed changes

Merge branch 'main' into try-rtd-builds

32b36a4

merelcht enabled auto-merge (squash) August 15, 2023 08:58

merelcht mentioned this pull request Aug 15, 2023

build(datasets): release 1.5.2 #305

Merged

4 tasks

merelcht disabled auto-merge August 15, 2023 09:39

merelcht merged commit 4942719 into main Aug 15, 2023
51 of 56 checks passed

merelcht deleted the try-rtd-builds branch August 15, 2023 09:40

merelcht mentioned this pull request Aug 15, 2023

Create kedro-datasets project on Read the Docs #261

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: Add docs rtd check on `kedro-datasets` #299

ci: Add docs rtd check on `kedro-datasets` #299

merelcht commented Aug 10, 2023 •

edited

Loading

stichbury commented Aug 11, 2023

merelcht commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

merelcht commented Aug 14, 2023

This comment was marked as resolved.

This comment was marked as resolved.

astrojuanlu left a comment

This comment was marked as resolved.

astrojuanlu commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

merelcht commented Aug 15, 2023

stichbury left a comment

astrojuanlu commented Aug 15, 2023

SajidAlamQB left a comment

noklam commented Aug 15, 2023

astrojuanlu commented Aug 15, 2023

ci: Add docs rtd check on kedro-datasets #299

ci: Add docs rtd check on kedro-datasets #299

Conversation

merelcht commented Aug 10, 2023 • edited Loading

Description

Development notes

Questions for reviewers

Checklist

stichbury commented Aug 11, 2023

merelcht commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

merelcht commented Aug 14, 2023

This comment was marked as resolved.

This comment was marked as resolved.

astrojuanlu left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

astrojuanlu commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

astrojuanlu commented Aug 14, 2023

merelcht commented Aug 15, 2023

stichbury left a comment

Choose a reason for hiding this comment

astrojuanlu commented Aug 15, 2023

SajidAlamQB left a comment

Choose a reason for hiding this comment

noklam commented Aug 15, 2023

astrojuanlu commented Aug 15, 2023

ci: Add docs rtd check on `kedro-datasets` #299

ci: Add docs rtd check on `kedro-datasets` #299

merelcht commented Aug 10, 2023 •

edited

Loading